Update main DataFusion README #4903
Conversation
github-actions
bot
added
the
documentation
|
@xudong963 or @Dandandan I wonder if you have any thoughts on this content? |
|
This is a much better than what we currently have right now, thank you for writing this up. I think having this stuff in the README still makes sense at this time since the website is not updated often (and we don't have a habit/rule for it AFAICT). To fuel community growth, I think we should avoid all kinds of friction that inhibit advertising/publishing what we have (and what we are working on). Since the README file is easy to update, and it is a common gateway page for many new users, I think it is OK to keep it "rich" during this phase of the project lifecycle. |
Co-authored-by: Andy Grove <andygrove73@gmail.com> Co-authored-by: jakevin <jakevingoo@gmail.com>
…fusion into alamb/improve_user_docs
Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
|
Benchmark runs are scheduled for baseline = aa8f139 and contender = b756d05. b756d05 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Which issue does this PR close?
re #3058 and #1814
Rationale for this change
I attended a conference last week CIDR and it was clear to me that DataFusion is more widely applicable than it is currently used, and part of that is lack of awareness in the broader community. Thus I wanted to try and communicate what DataFusion was / was good for more clearly.
Also as we have gathered more users we can now point to some more concrete examples
I also hope/plan to try and writeup a "datafusion architecture guide" soon as an additional way to encourage / grow our user base by making it more accessable for new people to see what we have (which is a lot!). Related to #980 from @xudong963
What changes are included in this PR?
See the rendered page here: https://github.com/alamb/arrow-datafusion/tree/alamb/improve_user_docs#datafusion
Discussion
Dicsussion:
How much of this content should go in the user guide https://arrow.apache.org/datafusion?
I like the idea of all the non-release specific content being in the user guide . However, the website isn't updated all that often (as it takes a manual process as I recall)
The README is what shows up on the main crates.io page: https://crates.io/crates/datafusion as well as the landing page of github.